Documentação - Documentação

get https://billing.iugu.com/api/invoices/current/pending_amount/{customer_workspace_id}

Retorna o valor pendente da fatura que o cliente tem em aberto (mês corrente)

Retorna o valor pendente da fatura que o cliente tem em aberto (mês corrente). O valor retornado é o da fatura atual do app que está fazendo a chamada, no workspace informado.

Permissão necessária: billing:invoices.current_pending_amount

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables
customer_workspace_id Required Type: string ID do workspace do cliente Ex: 4fHECmQtLdROI4fDLWMiLd

Headers
workspace_id Required Type: string Identificador do workspace Ex: 4fHECmQtLdROI4fDLWMiLd

Response

200

Valor pendente atual da fatura

amount

Number

Valor pendente atual da fatura

Ex: 1000.5

Example

1
2
3
{
  "amount": 1000.5
}

401

Quando houver erro de autenticação

errors

String

Mensagem de erro

Ex: Authentication Error, check your token and try again

Example

1
2
3
{
  "errors": "Authentication Error, check your token and try again"
}

422

ID do workspace inválido ou não fornecido

errors

String

Mensagem de erro

Ex: Cheque o Workspace ID e tente novamente mais tarde

Example

1
2
3
{
  "errors": "Cheque o Workspace ID e tente novamente mais tarde"
}

500

Em caso de erro de servidor ou externo.
Você deve tentar de novo dentro de alguns minutos.

errors

String

Mensagem de erro

Ex: Internal Server Error, please try again later.

Example

1
2
3
{
  "errors": "Internal Server Error, please try again later."
}

Back

Lista eventos com falhas nas últimas 23 horas.

Forward

Aplica um desconto na fatura que o cliente tem em aberto (mês corrente)